/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package androidx.health.connect.client.records

import androidx.health.connect.client.aggregate.AggregateMetric
import androidx.health.connect.client.records.metadata.Metadata
import androidx.health.connect.client.units.Energy
import androidx.health.connect.client.units.kilocalories
import java.time.Instant
import java.time.ZoneOffset

/**
 * Total energy burned by the user (in kilocalories), including active & basal energy burned (BMR).
 * Each record represents the total kilocalories burned over a time interval.
 */
public class TotalCaloriesBurnedRecord(
    override val startTime: Instant,
    override val startZoneOffset: ZoneOffset?,
    override val endTime: Instant,
    override val endZoneOffset: ZoneOffset?,
    /** Energy in [Energy] unit. Required field. Valid range: 0-1000000 kcal. */
    public val energy: Energy,
    override val metadata: Metadata = Metadata.EMPTY,
) : IntervalRecord {

    init {
        energy.requireNotLess(other = energy.zero(), "energy")
        energy.requireNotMore(other = MAX_ENERGY, name = "energy")
        require(startTime.isBefore(endTime)) { "startTime must be before endTime." }
    }

    /*
     * Generated by the IDE: Code -> Generate -> "equals() and hashCode()".
     */
    override fun equals(other: Any?): Boolean {
        if (this === other) return true
        if (other !is TotalCaloriesBurnedRecord) return false

        if (energy != other.energy) return false
        if (startTime != other.startTime) return false
        if (startZoneOffset != other.startZoneOffset) return false
        if (endTime != other.endTime) return false
        if (endZoneOffset != other.endZoneOffset) return false
        if (metadata != other.metadata) return false

        return true
    }

    /*
     * Generated by the IDE: Code -> Generate -> "equals() and hashCode()".
     */
    override fun hashCode(): Int {
        var result = energy.hashCode()
        result = 31 * result + startTime.hashCode()
        result = 31 * result + (startZoneOffset?.hashCode() ?: 0)
        result = 31 * result + endTime.hashCode()
        result = 31 * result + (endZoneOffset?.hashCode() ?: 0)
        result = 31 * result + metadata.hashCode()
        return result
    }

    override fun toString(): String {
        return "TotalCaloriesBurnedRecord(startTime=$startTime, startZoneOffset=$startZoneOffset, endTime=$endTime, endZoneOffset=$endZoneOffset, energy=$energy, metadata=$metadata)"
    }

    companion object {
        private val MAX_ENERGY = 1000_000.kilocalories

        /**
         * Metric identifier to retrieve total energy from
         * [androidx.health.connect.client.aggregate.AggregationResult].
         */
        @JvmField
        val ENERGY_TOTAL: AggregateMetric<Energy> =
            AggregateMetric.doubleMetric(
                dataTypeName = "TotalCaloriesBurned",
                aggregationType = AggregateMetric.AggregationType.TOTAL,
                fieldName = "energy",
                mapper = Energy::kilocalories,
            )
    }
}
